.. _ocastringactuator: 1.1.1.1.12 OcaStringActuator ============================= Class Hierarchy: :ref:`OcaRoot ` : :ref:`OcaWorker ` : :ref:`OcaActuator ` : :ref:`OcaBasicActuator ` : :ref:`OcaStringActuator ` .. cpp:class:: OcaStringActuator: OcaBasicActuator UTF-8 String actuator. **Properties**: .. _ocastringactuator_classid: .. cpp:member:: static const OcaClassID ClassID = "1.1.1.1.12" Number that uniquely identifies the class. Note that this differs from the object number, which identifies the instantiated object. This property is an override of the **OcaRoot** property. This property has id ``1.1``. .. _ocastringactuator_classversion: .. cpp:member:: static const OcaClassVersionNumber ClassVersion = 3 Identifies the interface version of the class. Any change to the class definition leads to a higher class version. This property is an override of the **OcaRoot** property. This property has id ``1.2``. .. _ocastringactuator_maxlen: .. cpp:member:: const OcaUint16 MaxLen Maximum allowed byte length of the **Setting** property. This property has id ``5.2``. .. _ocastringactuator_setting: .. cpp:member:: OcaString Setting Value. This property has id ``5.1``. Properties inherited from :ref:`ocabasicactuator`: - :cpp:texpr:`OcaClassID` :ref:`OcaRoot::ClassID ` - :cpp:texpr:`OcaClassVersionNumber` :ref:`OcaRoot::ClassVersion ` - :cpp:texpr:`OcaBoolean` :ref:`OcaRoot::Lockable ` - :cpp:texpr:`OcaLockState` :ref:`OcaRoot::LockState ` - :cpp:texpr:`OcaONo` :ref:`OcaRoot::ObjectNumber ` - :cpp:texpr:`OcaString` :ref:`OcaRoot::Role ` - :cpp:texpr:`OcaClassID` :ref:`OcaWorker::ClassID ` - :cpp:texpr:`OcaClassVersionNumber` :ref:`OcaWorker::ClassVersion ` - :cpp:texpr:`OcaBoolean` :ref:`OcaWorker::Enabled ` - :cpp:texpr:`OcaString` :ref:`OcaWorker::Label ` - :cpp:texpr:`OcaTimeInterval` :ref:`OcaWorker::Latency ` - :cpp:texpr:`OcaONo` :ref:`OcaWorker::Owner ` - :cpp:texpr:`OcaMap` :ref:`OcaWorker::PortClockMap ` - :cpp:texpr:`OcaList` :ref:`OcaWorker::Ports ` - :cpp:texpr:`OcaClassID` :ref:`OcaActuator::ClassID ` - :cpp:texpr:`OcaClassVersionNumber` :ref:`OcaActuator::ClassVersion ` - :cpp:texpr:`OcaClassID` :ref:`OcaBasicActuator::ClassID ` - :cpp:texpr:`OcaClassVersionNumber` :ref:`OcaBasicActuator::ClassVersion ` **Methods**: .. _ocastringactuator_getsetting: .. cpp:function:: OcaStatus GetSetting(OcaString &Setting) Gets the value of the **Setting** property. This method has id ``5.1``. - :cpp:expr:`Setting`: Output parameter. .. _ocastringactuator_setsetting: .. cpp:function:: OcaStatus SetSetting(OcaString Setting) Sets the value of the **Setting** property. This method has id ``5.2``. - :cpp:expr:`Setting`: Input parameter. .. _ocastringactuator_getmaxlen: .. cpp:function:: OcaStatus GetMaxLen(OcaUint16 &Len) Output parameter that shall hold the maximum allowable length of the Setting property if the method succeeds This method has id ``5.3``. - :cpp:expr:`Len`: Output parameter. Methods inherited from :ref:`ocabasicactuator`: - :ref:`OcaBasicActuator::GetClassIdentification ` - :ref:`OcaBasicActuator::GetLockable ` - :ref:`OcaBasicActuator::GetLockState ` - :ref:`OcaBasicActuator::GetRole ` - :ref:`OcaBasicActuator::SetLockNoWrite ` - :ref:`OcaBasicActuator::SetLockNoReadWrite ` - :ref:`OcaBasicActuator::Unlock ` - :ref:`OcaBasicActuator::AddPort ` - :ref:`OcaBasicActuator::DeletePort ` - :ref:`OcaBasicActuator::DeletePortClockMapEntry ` - :ref:`OcaBasicActuator::GetEnabled ` - :ref:`OcaBasicActuator::GetLabel ` - :ref:`OcaBasicActuator::GetLatency ` - :ref:`OcaBasicActuator::GetOwner ` - :ref:`OcaBasicActuator::GetPath ` - :ref:`OcaBasicActuator::GetPortClockMap ` - :ref:`OcaBasicActuator::GetPortClockMapEntry ` - :ref:`OcaBasicActuator::GetPortName ` - :ref:`OcaBasicActuator::GetPorts ` - :ref:`OcaBasicActuator::SetEnabled ` - :ref:`OcaBasicActuator::SetLabel ` - :ref:`OcaBasicActuator::SetLatency ` - :ref:`OcaBasicActuator::SetPortClockMap ` - :ref:`OcaBasicActuator::SetPortClockMapEntry ` - :ref:`OcaBasicActuator::SetPortName `